home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat2 / standard / sysinfo.z / sysinfo
Encoding:
Text File  |  2002-10-03  |  15.5 KB  |  265 lines

  1.  
  2.  
  3.  
  4. ssssyyyyssssiiiinnnnffffoooo((((2222))))                                                          ssssyyyyssssiiiinnnnffffoooo((((2222))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _ssss_yyyy_ssss_iiii_nnnn_ffff_oooo - get and set system information strings
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee <_ssss_yyyy_ssss_////_ssss_yyyy_ssss_tttt_eeee_mmmm_iiii_nnnn_ffff_oooo_...._hhhh>
  13.  
  14.      _llll_oooo_nnnn_gggg _ssss_yyyy_ssss_iiii_nnnn_ffff_oooo _((((_iiii_nnnn_tttt _cccc_oooo_mmmm_mmmm_aaaa_nnnn_dddd_,,,, _cccc_hhhh_aaaa_rrrr _****_bbbb_uuuu_ffff_,,,, _llll_oooo_nnnn_gggg _cccc_oooo_uuuu_nnnn_tttt_))))_;;;;
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      _ssss_yyyy_ssss_iiii_nnnn_ffff_oooo copies information relating to the UNIX system on which the
  18.      process is executing into the buffer pointed to by _b_u_f; _ssss_yyyy_ssss_iiii_nnnn_ffff_oooo can also
  19.      set certain information where appropriate _c_o_m_m_a_n_d_s are available.  _c_o_u_n_t
  20.      is the size of the buffer.
  21.  
  22.      The POSIX P1003.1 interface _ssss_yyyy_ssss_cccc_oooo_nnnn_ffff [see _ssss_yyyy_ssss_cccc_oooo_nnnn_ffff(2)] provides a similar
  23.      class of configuration information, but returns an integer rather than a
  24.      string.
  25.  
  26.      The _c_o_m_m_a_n_ds available are:
  27.  
  28.      _SSSS_IIII______SSSS_YYYY_SSSS_NNNN_AAAA_MMMM_EEEE    Copy into the array pointed to by _b_u_f the string that would
  29.                    be returned by _uuuu_nnnn_aaaa_mmmm_eeee [see _uuuu_nnnn_aaaa_mmmm_eeee(2)] in the _s_y_s_n_a_m_e field.
  30.                    This is the name of the implementation of the operating
  31.                    system, for example, _S_y_s_t_e_m _V or _U_T_S.
  32.  
  33.      _SSSS_IIII______HHHH_OOOO_SSSS_TTTT_NNNN_AAAA_MMMM_EEEE   Copy into the array pointed to by _b_u_f a string that names
  34.                    the present host machine.  This is the string that would be
  35.                    returned by _uuuu_nnnn_aaaa_mmmm_eeee in the _n_o_d_e_n_a_m_e field.  This hostname or
  36.                    nodename is often the name the machine is known by locally.
  37.  
  38.                    The _h_o_s_t_n_a_m_e is the name of this machine as a node in some
  39.                    network; different networks may have different names for
  40.                    the node, but presenting the nodename to the appropriate
  41.                    network Directory or name-to-address mapping service should
  42.                    produce a transport end point address.  The name may not be
  43.                    fully qualified.
  44.  
  45.                    Internet host names may be up to 256 bytes in length (plus
  46.                    the terminating null).
  47.  
  48.      _SSSS_IIII______SSSS_EEEE_TTTT______HHHH_OOOO_SSSS_TTTT_NNNN_AAAA_MMMM_EEEE
  49.                    Copy the null-terminated contents of the array pointed to
  50.                    by _b_u_f into the string maintained by the kernel whose value
  51.                    will be returned by succeeding calls to _ssss_yyyy_ssss_iiii_nnnn_ffff_oooo with the
  52.                    command _SSSS_IIII______HHHH_OOOO_SSSS_TTTT_NNNN_AAAA_MMMM_EEEE.  This command requires that the
  53.                    effective-user-id be super-user.
  54.  
  55.      _SSSS_IIII______RRRR_EEEE_LLLL_EEEE_AAAA_SSSS_EEEE    Copy into the array pointed to by _b_u_f the string that would
  56.                    be returned by _uuuu_nnnn_aaaa_mmmm_eeee in the _r_e_l_e_a_s_e field.  Typical values
  57.                    might be _4._0 or _3._2.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ssssyyyyssssiiiinnnnffffoooo((((2222))))                                                          ssssyyyyssssiiiinnnnffffoooo((((2222))))
  71.  
  72.  
  73.  
  74.      _SSSS_IIII______VVVV_EEEE_RRRR_SSSS_IIII_OOOO_NNNN    Copy into the array pointed to by _b_u_f the string that would
  75.                    be returned by _uuuu_nnnn_aaaa_mmmm_eeee in the _v_e_r_s_i_o_n field.  The syntax and
  76.                    semantics of this string are defined by the system
  77.                    provider.  Under IRIX, this is the date and time that the
  78.                    system was generated and has the form mmmmmmmmddddddddhhhhhhhhmmmmmmmm.
  79.  
  80.      _SSSS_IIII______MMMM_AAAA_CCCC_HHHH_IIII_NNNN_EEEE    Copy into the array pointed to by _b_u_f the string that would
  81.                    be returned by _uuuu_nnnn_aaaa_mmmm_eeee in the _m_a_c_h_i_n_e field, for example,
  82.                    _I_P_2_7 or _I_P_3_0.
  83.  
  84.      _SSSS_IIII______AAAA_RRRR_CCCC_HHHH_IIII_TTTT_EEEE_CCCC_TTTT_UUUU_RRRR_EEEE
  85.                    Copy into the array pointed to by _b_u_f a string describing
  86.                    the instruction set architecture of the current system, for
  87.                    example, _M_I_P_S-_I_I, _m_3_2_1_0_0, or _i_8_0_4_8_6.  These names may not
  88.                    match predefined names in the C language compilation
  89.                    system.
  90.  
  91.      _SSSS_IIII______HHHH_WWWW______PPPP_RRRR_OOOO_VVVV_IIII_DDDD_EEEE_RRRR
  92.                    Copies the name of the hardware manufacturer into the array
  93.                    pointed to by _b_u_f.
  94.  
  95.      _SSSS_IIII______HHHH_WWWW______SSSS_EEEE_RRRR_IIII_AAAA_LLLL  Copy into the array pointed to by _b_u_f a string which is the
  96.                    ASCII representation of the 32 bit hardware-specific
  97.                    identifier of the physical machine on which the system call
  98.                    is executed.  Note that this may be implemented in Read-
  99.                    Only Memory, via software constants set when building the
  100.                    operating system, or by other means, and may contain non-
  101.                    numeric characters.  It is anticipated that manufacturers
  102.                    will not issue the same ``32-bit identifier'' to more than
  103.                    one physical machine.  The pair of strings returned by
  104.                    _SSSS_IIII______HHHH_WWWW______PPPP_RRRR_OOOO_VVVV_IIII_DDDD_EEEE_RRRR and _SSSS_IIII______HHHH_WWWW______SSSS_EEEE_RRRR_IIII_AAAA_LLLL is likely to be unique
  105.                    across all vendor's System V implementations.
  106.  
  107.      _SSSS_IIII______SSSS_RRRR_PPPP_CCCC______DDDD_OOOO_MMMM_AAAA_IIII_NNNN
  108.                    This command is not supported under _I_R_I_X.
  109.  
  110.      _SSSS_IIII______SSSS_EEEE_TTTT______SSSS_RRRR_PPPP_CCCC______DDDD_OOOO_MMMM_AAAA_IIII_NNNN
  111.                    This command is not supported under _I_R_I_X.
  112.  
  113.      _SSSS_IIII______IIII_NNNN_IIII_TTTT_TTTT_AAAA_BBBB______NNNN_AAAA_MMMM_EEEE
  114.                    Copy into the array pointed to by _b_u_f a string that is the
  115.                    pathname of the _iiii_nnnn_iiii_tttt_tttt_aaaa_bbbb file used by the currently running
  116.                    bootable operating system.  This is the same as the file
  117.                    specified by the _IIII_NNNN_IIII_TTTT_TTTT_AAAA_BBBB keyword found in the _ssss_yyyy_ssss_tttt_eeee_mmmm file
  118.                    [see _ssss_yyyy_ssss_tttt_eeee_mmmm(4)].
  119.  
  120.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______VVVV_EEEE_NNNN_DDDD_OOOO_RRRR
  121.                    Copy into the array pointed to by _b_u_f a string which is the
  122.                    name of the company providing the system. The vendor is the
  123.                    company actually selling the product rather than the
  124.                    company which built the product. Eg: "Silicon Graphics
  125.                    Inc".
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ssssyyyyssssiiiinnnnffffoooo((((2222))))                                                          ssssyyyyssssiiiinnnnffffoooo((((2222))))
  137.  
  138.  
  139.  
  140.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______OOOO_SSSS______PPPP_RRRR_OOOO_VVVV_IIII_DDDD_EEEE_RRRR
  141.                    Copy into the array pointed to by _b_u_f a string which is the
  142.                    name of the company providing the operating system. This is
  143.                    the name of the company which built the operating system.
  144.                    Eg: "Silicon Graphics Inc".
  145.  
  146.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______OOOO_SSSS______NNNN_AAAA_MMMM_EEEE
  147.                    Copy into the array pointed to by _b_u_f a string which is the
  148.                    name of the operating system. Eg: "IRIX".
  149.  
  150.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______HHHH_WWWW______NNNN_AAAA_MMMM_EEEE
  151.                    Copy into the array pointed to by _b_u_f a string which is the
  152.                    name of the hardware platform. This is the name of the
  153.                    platform in the pricelist. Eg: "IP19"
  154.  
  155.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______NNNN_UUUU_MMMM______PPPP_RRRR_OOOO_CCCC_EEEE_SSSS_SSSS_OOOO_RRRR_SSSS
  156.                    Copy into the array pointed to by _b_u_f a string which is the
  157.                    ASCII representation of the number of configured
  158.                    processors. Eg: "16"
  159.  
  160.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______HHHH_OOOO_SSSS_TTTT_IIII_DDDD
  161.                    Copy into the array pointed to by _b_u_f a string which is the
  162.                    ASCII representation of the host id in hex.  This example
  163.                    uses sgi.sgi.com, which has an internet address of
  164.                    192.26.75.5. Eg: "c01a4b05"
  165.  
  166.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______OOOO_SSSS_RRRR_EEEE_LLLL______MMMM_AAAA_JJJJ
  167.                    Copy into the array pointed to by _b_u_f a string which is the
  168.                    ASCII representation of the  OS major release number.
  169.  
  170.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______OOOO_SSSS_RRRR_EEEE_LLLL______MMMM_IIII_NNNN
  171.                    Copy into the array pointed to by _b_u_f a string which is the
  172.                    ASCII representation of the OS minor release number.
  173.  
  174.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______OOOO_SSSS_RRRR_EEEE_LLLL______PPPP_AAAA_TTTT_CCCC_HHHH
  175.                    Copy into the array pointed to by _b_u_f a string which is the
  176.                    ASCII representation of the OS patch release number.
  177.  
  178.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______PPPP_RRRR_OOOO_CCCC_EEEE_SSSS_SSSS_OOOO_RRRR_SSSS
  179.                    Copy into the array pointed to by _b_u_f a string which is the
  180.                    processor type. In the case of a multiprocessor, this will
  181.                    be a comma separated list with _MIPS_SI_NUM_PROCESSORS
  182.                    entries.
  183.  
  184.      ______MMMM_IIII_PPPP_SSSS______SSSS_IIII______AAAA_VVVV_AAAA_IIII_LLLL______PPPP_RRRR_OOOO_CCCC_EEEE_SSSS_SSSS_OOOO_RRRR_SSSS
  185.                    Copy into the array pointed to by _b_u_f a string which is the
  186.                    ASCII representation of the number of processors available
  187.                    for running unrestricted processes.
  188.  
  189.      _ssss_yyyy_ssss_iiii_nnnn_ffff_oooo fails if one or both of the following are true:
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ssssyyyyssssiiiinnnnffffoooo((((2222))))                                                          ssssyyyyssssiiiinnnnffffoooo((((2222))))
  203.  
  204.  
  205.  
  206.      _EEEE_PPPP_EEEE_RRRR_MMMM         The process does not have appropriate privilege for a SET
  207.                    command.
  208.  
  209.      _EEEE_IIII_NNNN_VVVV_AAAA_LLLL        _b_u_f does not point to a valid address, or the data for a
  210.                    SET command exceeds the limits established by the
  211.                    implementation.
  212.  
  213. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  214.      Upon successful completion, the value returned indicates the buffer size
  215.      in bytes required to hold the complete value and the terminating null
  216.      character.  If this value is no greater than the value passed in _c_o_u_n_t,
  217.      the entire string was copied; if this value is greater than _c_o_u_n_t, the
  218.      string copied into _b_u_f has been truncated to _c_o_u_n_t-_1 bytes plus a
  219.      terminating null character.
  220.  
  221.      Otherwise, a value of -1 is returned and _eeee_rrrr_rrrr_nnnn_oooo is set to indicate the
  222.      error.
  223.  
  224. UUUUSSSSAAAAGGGGEEEE
  225.      There is in many cases no corresponding programmatic interface to set
  226.      these values; such strings are typically settable only by the system
  227.      administrator modifying entries in the _mmmm_aaaa_ssss_tttt_eeee_rrrr_...._dddd directory or the code
  228.      provided by the particular OEM reading a serial number or code out of
  229.      read-only memory, or hard-coded in the version of the operating system.
  230.  
  231.      A good starting guess for _c_o_u_n_t is 257, which is likely to cover all
  232.      strings returned by this interface in typical installations.
  233.  
  234. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  235.      _uuuu_nnnn_aaaa_mmmm_eeee(2), _gggg_eeee_tttt_hhhh_oooo_ssss_tttt_nnnn_aaaa_mmmm_eeee(3), _gggg_eeee_tttt_hhhh_oooo_ssss_tttt_iiii_dddd(3), _ssss_yyyy_ssss_cccc_oooo_nnnn_ffff(3C)
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.